docs: update readme from mariadb with port binding, tags, remove double spaces and informations #2552
Conversation
There was a problem hiding this comment.
I've left a few notes 👍
I'll also explicitly CC the mariadb image maintainers: @grooverdan @dbart @fauust
| @@ -1,16 +1,17 @@ | |||
| # Use root/example as user/password credentials | |||
| version: '3.1' | |||
There was a problem hiding this comment.
If we drop this, we also need to drop the references to docker stack deploy; see also #2516 (comment)
There was a problem hiding this comment.
If we drop this, we also need to drop the references to
docker stack deploy; see also #2516 (comment)
https://docs.docker.com/reference/compose-file/version-and-name/#version-top-level-element-obsolete
There was a problem hiding this comment.
more explicitly:
https://docs.docker.com/engine/swarm/stack-deploy "The docker stack deploy command uses the legacy Compose file version 3 format, used by Compose V1"
https://docs.docker.com/compose/intro/history/ " (from image - Compose V1 / Compose file version - "Used version top level element". So if you remove version, remove the docker stack deploy like @tianon said.
mariadb/stack.yml
Outdated
| image: mariadb:11.7-ubi | ||
| restart: always | ||
| environment: | ||
| MARIADB_ROOT_PASSWORD: example | ||
| ports: | ||
| - 3306:3306 | ||
|
|
||
| adminer: | ||
| image: adminer | ||
| image: adminer:4.17.1 |
There was a problem hiding this comment.
These really specific version numbers are likely to bitrot quickly, so we don't typically suggest being so particular unless it's actually necessary to be.
(Also, see the prior note about exposed database ports.)
There was a problem hiding this comment.
especially with 11.7 as a short term support release. Perhaps use a lts /lts-ubi tag and I guess something for adminer. The purpose of compose files was self contained, so especially with something link adminer, exposing ports seems unnecessary.
On env variables including something like MARIADB_AUTO_UPGRADE=1 would smooth the upgrade paths.
I wouldn't mind seeing the healthcheck and service dependency like https://mariadb.com/kb/en/using-healthcheck-sh/#compose-file-example here as a practically of showing of getting the database up before the services that connect to it (and might fail if they can't connect). (edit: assuming docker stack compatibility).
There was a problem hiding this comment.
These really specific version numbers are likely to bitrot quickly, so we don't typically suggest being so particular unless it's actually necessary to be.
(Also, see the prior note about exposed database ports.)
updated.
especially with 11.7 as a short term support release. Perhaps use a
lts/lts-ubitag and I guess something for adminer. The purpose of compose files was self contained, so especially with something link adminer, exposing ports seems unnecessary.On env variables including something like
MARIADB_AUTO_UPGRADE=1would smooth the upgrade paths.I wouldn't mind seeing the healthcheck and service dependency like https://mariadb.com/kb/en/using-healthcheck-sh/#compose-file-example here as a practically of showing of getting the database up before the services that connect to it (and might fail if they can't connect). (edit: assuming
docker stackcompatibility).
I like the idea.
I think another section, with this more complete example, would be better. Then we can have a more basic section and a more advanced one.
There was a problem hiding this comment.
This thread isn't resolved (references in stack.yml are still too-specific).
|
@tianon, @grooverdan |
This comment was marked as duplicate.
This comment was marked as duplicate.
Sorry, something went wrong.
|
sorry for delay. I'll get to it next week. |
|
@grooverdan |
| @@ -1,16 +1,17 @@ | |||
| # Use root/example as user/password credentials | |||
| version: '3.1' | |||
There was a problem hiding this comment.
more explicitly:
https://docs.docker.com/engine/swarm/stack-deploy "The docker stack deploy command uses the legacy Compose file version 3 format, used by Compose V1"
https://docs.docker.com/compose/intro/history/ " (from image - Compose V1 / Compose file version - "Used version top level element". So if you remove version, remove the docker stack deploy like @tianon said.
I update the both tags to latest |
This pull request includes updates to the
mariadbdocumentation and configuration files to improve clarity and compatibility, as well as to specify versions for certain images.Documentation improvements:
mariadb/content.md: Added an important note about the%%IMAGE%%tags to highlight thelatestandltsversions.mariadb/content.md: Updated the Docker compose command to usedocker composeinstead ofdocker-composefor consistency with the latest Docker CLI.mariadb/content.md: Added a section on port binding to explain how to expose the container port to the host port using the-pargument in thedocker runcommand.Configuration updates:
mariadb/stack.yml: Specified the image versions formariadbandadminerto ensure consistency and compatibility. Themariadbimage is updated to11.7-ubiandadminerto4.17.1.mariadb/stack.yml: Remove docker compose version on file header - the docker compose version is obsolete